package com.example.apidocserver.domain.document.service;

import com.example.apidocserver.domain.document.entity.ApiParam;

import java.util.List;

/**
 * 接口入参对象(ApiParam)表服务接口
 *
 * @author makejava
 * @since 2023-03-07 22:37:23
 */
public interface ApiParamService {

    /**
     * 通过ID查询单条数据
     *
     * @param id 主键
     * @return 实例对象
     */
    ApiParam queryById(Integer id);

    /**
     * 查询所有对象
     *
     * @return 查询结果
     */
    List<ApiParam> queryAll();

    /**
     * 根据对象查询
     *
     * @param apiParam 筛选条件
     * @return 查询结果
     */
    List<ApiParam> queryByEntity(ApiParam apiParam);

    /**
     * 新增数据
     *
     * @param apiParam 实例对象
     * @return 实例对象
     */
    ApiParam insert(ApiParam apiParam);

    /**
     * 修改数据
     *
     * @param apiParam 实例对象
     * @return 实例对象
     */
    ApiParam update(ApiParam apiParam);

    /**
     * 通过主键删除数据
     *
     * @param id 主键
     * @return 是否成功
     */
    boolean deleteById(Integer id);

    /**
     * 查询接口参数说明数据
     *
     * @param apiId 接口id
     * @return 参数对象结合
     */
    List<ApiParam> queryByApiId(Integer apiId);

    /**
     * 新建参数说明
     *
     * @param apiParamNewList 参数说明对象
     */
    void insertList(List<ApiParam> apiParamNewList);

    /**
     * 新增或修改参数说明
     *
     * @param paramDescVo 参数说明对象
     * @return 参数说明对象
     */
    ApiParam upsertParam(ApiParam paramDescVo);
}
